/*
 *  Copyright (C) 2011 JiangHongTiao <jjurco.sk_gmail.com>
 * 
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 * 
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 * 
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package sk.lieskove.jianghongtiao.websearch.api.google.search;

import java.net.URL;
import java.util.Collection;
import java.util.List;

/**
 *
 * @author xjuraj
 */
public interface GWSResponseData {

    /**
     * get cursor data about web search
     * @return cursor data about web search
     */
    public GWSCursor getCursor();

    /**
     * get array of found pages with info
     * @return array of found pages with info
     */
    public List<GWSResult> getResults();
    /**
     * get collection of URL resources 
     * @return array of URLs of found resources
     */
    public List<URL> getURLResults();

    /**
     * get number of results
     * @return
     */
    public int googleWSCount();

    /**
     * get specific found page
     * @param index index item
     * @return found page info
     */
    public GWSResult getResult(int index);

    /**
     * append all new results to result array
     * @param results collection of new results
     * @return true if this list changed as a result of the call
     */
    public boolean appendResults(Collection<GWSResult> results);

}
